Header Examples
The following table provides examples of syntax for indicating header fields.
Header Field Syntax Examples
Header |
Description |
---|---|
header.to |
Defines the top level of the To header. |
header.to.url.user |
Defines the user part in the header SIP URL. |
header.from.url.host |
Defines the host part in the From header. |
header.from.name |
Defines the display name in the From header. |
header.newheader |
Defines a header newheader. |
header.contact.param.newparam |
Defines the parameter newparam of a Contact header. |
header.refer-to.url.host |
Defines the host part of the Refer-To header. |
header.diversion.reason |
Defines the Reason parameter in the Diversion header. |
header.supported.capabilities.path |
Defines the supported headers capabilities path. |
header.supported.capabilities.replaces |
Defines the supported headers capabilities replaces. |
header.max-forwards.val |
Defines the value of the Max-Forwards header. |
header.request-uri.methodtype |
Defines the method in the Request-URI. |
header.remote-party-id.0.partytype |
Defines the party type in the first Remote-Party-ID header. |
header.contact.3 |
Defines the third Contact header. |
header.via.2.url.user |
Defines the user part of the second Via header. |
The following table provides examples of manipulation rules for headers.
Header Field Manipulation Rules Examples
Message Type |
Condition |
Action |
Action Type |
Action |
Explanation |
---|---|---|---|---|---|
register. |
header.from.url.user == '101' OR header.from.url.user == '1000' |
header.from.url.user |
Modify |
'2000' |
If the user part of the From header's URL in the REGISTER request is "100" or 1000", change it to "2000". |
register |
|
header.to.url.host.name |
Modify |
'audiocodes.com' |
In the REGISTER message, change the host part of the To header's URL to "audiocodes.com". |
invite |
|
header.from.name |
Modify |
header.contact. |
In the INVITE message, change the display name of the From header to the user part of the Contact header's URL. |
invite. |
|
header.newheader |
Add |
'information to client' |
In the INVITE request, add a header called "newheader" with the value "'information to client'". |
subscribe |
header.via.transporttype=='1' |
header.to.param |
Add |
'TCP' |
If the transport type of the Via header in the SUBSCRIBE message is "1" (TCP), add the transport type "TCP" to the To header. |
invite |
header.allow !contains 'REFER' |
header.allow |
Modify |
header.allow +',REFER' |
If the Allow header in the INVITE message doesn't include the value "REFER", add "REFER" in the outgoing INVITE. |